[Action May Be Required] Upcoming Changes in Next Rollouts Release 2.17.0 / 5-15 November 2025
We are introducing important updates in our next Rollouts release scheduled for November 2025. These changes may require updates in your automation or integration processes.
TL;DR
Change: Action fields status
/detailstatus
will be changed/renamed to active
/status
(status
semantic is changed).
/rest/v1/actions
and /rest/v1/actions/{actionId}
), and:
- searching actions by the
status
ordetailstatus
fields - processing the
status
ordetailStatus
fields in the JSON responses.
Reason: The new names and semantics are more natural and compliant with the UI views
Affected API
- Only the Actions Management REST API is affected
- The affected endpoints are /rest/v1/actions and /rest/v1/actions/{actionId}
Non-Backward Compatible Changes (Next Release):
- The
status
search field will adopt the semantic of the currentdetailstatus
field (e.g., scheduled, running). - The
detailstatus
search field will be deprecated. - The
status
field in the action JSON will reflect detailed status (e.g., scheduled, running). - The
detailStatus
field in the action JSON will be deprecated.
Relevant changes already deployed (Last Release, 2.16.0 / October 7, 2025):
- A new action search field,
active
(true/false), is available. Please useactive
instead ofstatus
(pending/finished). - The REST response for action retrieval includes an
active
(true/false) field. Use this instead ofstatus
.
Required Actions:
- Before the next release: If you use
status
as a search field or in action JSON, switch toactive
(true/false). - After the next release: If you use
detailstatus
as a search field ordetailStatus
in action JSON, switch tostatus
.
Note: you could apply the actions before and after the next release (in two steps), or together with the next release (in one step with a bit of downtime)
Contact: If these changes impact your processes or you have concerns, please don't hesitate to contact us at Bosch IoT Support by October 29, 2025, to coordinate and discuss your needs.
Thank you for your attention and cooperation.